Nachrichten über einen bestimmten Zeitraum abrufen
Mit dieser Methode können Sie alle Ihre Nachrichten über einen bestimmten Zeitraum hinweg abrufen.
GET
/messages
Abfrage-Parameter
date_start
notwendig
|
Einen Filter hinzufügen, um die Kampagnen abzurufen, deren Sendedatum nach diesem Datum liegt. Das Format des Datums muss wie folgt sein: Y-m-d H:i:s |
date_end
notwendig
|
Einen Filter hinzufügen, um die Kampagnen abzurufen, deren Sendedatum vor diesem Datum liegt. Das Format des Datums muss wie folgt sein: Y-m-d H:i:s |
destination | Fügen Sie einen Filter hinz, um Kampagnen abzurufen, die diese Telefonnummer als Ziel haben |
message | Fügen Sie einen Filter hinzu, um Kampagnen zu finden, die diesen Text im Inhalt enthalten |
type | Fügen Sie einen Filter für die Art der Nachricht hinzu: empfangene Nachricht (messages-in ), gesendete Nachricht (messages-out ). By default, all messages are returned |
country | Fügen Sie einen Filter für die Abfrage nach dem Absenderland hinzu. Das Länderformat muss alpha2 sein: FR |
status | Add a filter on message status. Available status : delivered , sent , waiting , moderation , denied , not_sent , undelivered |
start | Sie können den Startdatensatz für die Seitennummerierung festlegen. Standard 0 |
length | Sie können die Anzahl der Datensätze festlegen, die pro Abfrage abgerufen werden sollen. Standard 100, maximal 1000 |
sort | Sie können nach date , destination , sender , status . Füge - hinzu, um in absteigender Reihenfolge zu sortieren, zum Beispiel -date |
Beispiele
GET /messages?date_start=2023-09-01 00:00:00&date_end=2023-09-31 23:59:59 HTTP/1.1
Host: api.smsfactor.com
Accept: application/json
Authorization: Bearer your.token
Ergebnisformat
{
"status": 1,
"message": "OK",
"totalRecords": 2,
"totalDisplayRecords": 2,
"messages": [
{
"campaign_id": 123,
"client_id": 1,
"client_message_id": "my id",
"contact_list_id": "",
"message": "Message via API",
"message_length": 15,
"cost": 1,
"country": "FR",
"destination": "33612345678",
"message_id": 138,
"sender": "",
"date": "2024-09-08 02:08:32",
"dlr_date": "2024-09-08 02:08:32",
"status": "SENT",
"status_details": "SENT",
"type": "sms_mt"
},
{
"campaign_id": 123,
"client_id": 1,
"client_message_id": "my id",
"contact_list_id": "",
"message": "An answer",
"message_length": 9,
"cost": 0,
"country": "",
"destination": "36000",
"message_id": 256,
"sender": "33612345678",
"date": "2024-09-08 02:08:32",
"dlr_date": "",
"status": "incoming_message",
"status_details": "",
"type": "sms_mo"
}
]
}
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>1</status>
<message>OK</message>
<totalRecords>2</totalRecords>
<totalDisplayRecords>2</totalDisplayRecords>
<messages>
<campaign_id>123</campaign_id>
<client_id>1</client_id>
<client_message_id>my id</client_message_id>
<contact_list_id></contact_list_id>
<message>Message via API</message>
<message_length>15</message_length>
<cost>1</cost>
<country>FR</country>
<destination>33612345678</destination>
<message_id>138</message_id>
<sender></sender>
<date>"2024-09-08 02:08:32"</date>
<dlr_date>"2024-09-08 02:08:32"</dlr_date>
<status>SENT</status>
<status_details>SENT</status_details>
<type>sms_mt</type>
</messages>
<messages>
<campaign_id>123</campaign_id>
<client_id>1</client_id>
<client_message_id>my id</client_message_id>
<contact_list_id></contact_list_id>
<message>An answer</message>
<message_length>9</message_length>
<cost>0</cost>
<country></country>
<destination>36000</destination>
<message_id>256</message_id>
<sender>33612345678</sender>
<date>"2024-09-08 02:08:32"</date>
<dlr_date></dlr_date>
<status>incoming_message</status>
<status_details></status_details>
<type>sms_mo</type>
</messages>
</response>
Satzung
status | Beschreibung |
---|---|
sent | Die Nachricht wurde abgeschickt. |
waiting | Die Nachricht wartet darauf, gesendet zu werden (in der Zukunft geplante Kampagne). |
delivered | Die Nachricht wurde empfangen. |
moderation | Die Nachricht wird moderiert. Eine menschliche Handlung ist erforderlich, um die Nachricht zu validieren oder zurückzuweisen (im Falle von Betrug). |
denied | Die Nachricht wurde abgelehnt. |
not_sent | Die Nachricht wurde nicht gesendet (ungültige Nummer, unzulässiges Land, unzulässige Zeiten, Überschwemmungsschutz...). |
undelivered | Der Betreiber teilt uns mit, dass die Nachricht nicht empfangen wurde (nicht zugewiesene Nummer, Netzproblem, ausgeschaltetes Telefon...). |